Add integration guide url to buf plugin config #2511
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pkwarren
reviewed
Oct 23, 2023
| @@ -381,6 +381,8 @@ message CreateCuratedPluginRequest { | |||
| string license_url = 16; | |||
| // Visibility indicates whether the plugin is public or private. | |||
| CuratedPluginVisibility visibility = 17; | |||
| // The URL leading to the integration guide of the plugin, if available. | |||
| string integration_guide_url = 18; | |||
There was a problem hiding this comment.
Shouldn't this also be added to CuratedPlugin message type?
There was a problem hiding this comment.
Sure, I can add it in the same PR. I wanted to break this into 2 PR's, the config+request side, but no issue also updating the core type.
pkwarren
approved these changes
Oct 23, 2023
bufdev
approved these changes
Oct 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR extends the buf.plugin.yaml configuration to allow for a
integration_guide_url.This field is intended to link to an external integration guide for the plugin, e.g.,
https://buf.build/docs/bsr/remote-packages/swift#doc-content